/*
 * Copyright 2017-2024 original authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.micronaut.http.util;

import org.jspecify.annotations.NonNull;
import jakarta.annotation.Nullable;

/**
 * API to sanitize a String of HTML.
 * @author Sergio del Amo
 * @since 4.7.0
 */
@FunctionalInterface
public interface HtmlSanitizer {
    /**
     * Sanitizes a string of HTML.
     * @param html the String of HTML to Sanitize
     * @return a sanitized version of the supplied HTML String.
     */
    @NonNull
    String sanitize(@Nullable String html);
}
